Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger docs for RepresentationManagement::V0::AccreditedEntitiesForAppointController #19522

Conversation

opticbob
Copy link
Contributor

@opticbob opticbob commented Nov 19, 2024

Summary

  • This work is behind a feature toggle (flipper): YES: The feature that this documentation is for is behind a feature flag.
  • (Summarize the changes that have been made to the platform): This adds swagger docs for RepresentationManagement::V0::AccreditedEntitiesForAppointController.
  • (If bug, how to reproduce)
  • (What is the solution, why is this the solution?): We were encouraged to have swagger docs for all of our endpoints before release.
  • (Which team do you work for, does your team own the maintenance of this component?): FAR/ARM. We own the maintenance.
  • (If introducing a flipper, what is the success criteria being targeted?)

Related issue(s)

Testing done

  • New code is covered by unit tests
  • Describe what the old behavior was prior to the change: This endpoint wasn't documented.
  • Describe the steps required to verify your changes are working as expected. Exclusively stating 'Specs run' is NOT acceptable as appropriate testing: Start the server and point a Swagger-UI at http://localhost:3000/representation_management/v0/apidocs. You'll be able to see these docs and all our others there.
  • If this work is behind a flipper:
    • Tests need to be written for both the flipper on and flipper off scenarios. Docs.
    • What is the testing plan for rolling out the feature?

Screenshots

Screenshot 2024-11-26 at 15-51-03 Swagger UI

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas): This just impacts the documentation for the representation_management module.

Acceptance criteria

  • I added unit tests and integration tests for each feature (if applicable).
  • No error nor warning in the console.
  • Events are being sent to the appropriate logging solution
  • Documentation has been updated (link to documentation) This PR is the documentation.
  • No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
  • Feature/bug has a monitor built into Datadog (if applicable)
  • If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
  • I added a screenshot of the developed feature

@va-vfs-bot va-vfs-bot temporarily deployed to 91484-add-swagger-documentation-for-representationmanagementv0accreditedentitiesforappointcontroller/main/main November 19, 2024 21:59 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 91484-add-swagger-documentation-for-representationmanagementv0accreditedentitiesforappointcontroller/main/main November 19, 2024 22:34 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 91484-add-swagger-documentation-for-representationmanagementv0accreditedentitiesforappointcontroller/main/main November 20, 2024 20:18 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 91484-add-swagger-documentation-for-representationmanagementv0accreditedentitiesforappointcontroller/main/main November 20, 2024 23:47 Inactive
@opticbob opticbob self-assigned this Nov 21, 2024
…entationmanagementv0accreditedentitiesforappointcontroller
jvcAdHoc
jvcAdHoc previously approved these changes Nov 27, 2024
…entationmanagementv0accreditedentitiesforappointcontroller
@va-vfs-bot va-vfs-bot temporarily deployed to 91484-add-swagger-documentation-for-representationmanagementv0accreditedentitiesforappointcontroller/main/main December 3, 2024 18:27 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 91484-add-swagger-documentation-for-representationmanagementv0accreditedentitiesforappointcontroller/main/main December 3, 2024 19:24 Inactive
@opticbob
Copy link
Contributor Author

opticbob commented Dec 3, 2024

I'm closing this to open a fresh PR on the same branch. This PR is in a stuck state where it says it's still processing. New commits aren't showing up and all checks are frozen as well. It has been stuck for at least two hours. There was a github incident around PRs but their status page says that has resolved and this never budged.

Screenshot 2024-12-03 151245

I'll update this closed PR with the new PR details when I have them.

@opticbob opticbob closed this Dec 3, 2024
@opticbob
Copy link
Contributor Author

opticbob commented Dec 3, 2024

New PR: #19691

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants